<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Securimage</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> Securimage</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Securimage CAPTCHA Class.</p>
		<p class="notes">
			Located in <a class="field" href="_securimage---securimage.php.html">/securimage/securimage.php</a> (line <span class="field">82</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																																																																																																																																																																																																																																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$arc_linethrough" title="details" class="var-name">$arc_linethrough</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$arc_line_colors" title="details" class="var-name">$arc_line_colors</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$audio_path" title="details" class="var-name">$audio_path</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$charset" title="details" class="var-name">$charset</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$code_length" title="details" class="var-name">$code_length</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$draw_angled_lines" title="details" class="var-name">$draw_angled_lines</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$draw_lines" title="details" class="var-name">$draw_lines</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$draw_lines_over_text" title="details" class="var-name">$draw_lines_over_text</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$font_size" title="details" class="var-name">$font_size</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$gd_font_file" title="details" class="var-name">$gd_font_file</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$gd_font_size" title="details" class="var-name">$gd_font_size</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$image_bg_color" title="details" class="var-name">$image_bg_color</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$image_height" title="details" class="var-name">$image_height</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$image_type" title="details" class="var-name">$image_type</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$image_width" title="details" class="var-name">$image_width</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$line_color" title="details" class="var-name">$line_color</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$line_distance" title="details" class="var-name">$line_distance</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$line_thickness" title="details" class="var-name">$line_thickness</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$multi_text_color" title="details" class="var-name">$multi_text_color</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$text_angle_maximum" title="details" class="var-name">$text_angle_maximum</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$text_angle_minimum" title="details" class="var-name">$text_angle_minimum</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$text_color" title="details" class="var-name">$text_color</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$text_maximum_distance" title="details" class="var-name">$text_maximum_distance</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$text_minimum_distance" title="details" class="var-name">$text_minimum_distance</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$text_transparency_percentage" title="details" class="var-name">$text_transparency_percentage</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">int</span>
					<a href="#$text_x_start" title="details" class="var-name">$text_x_start</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$ttf_file" title="details" class="var-name">$ttf_file</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$use_gd_font" title="details" class="var-name">$use_gd_font</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$use_multi_text" title="details" class="var-name">$use_multi_text</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">boolean</span>
					<a href="#$use_transparent_text" title="details" class="var-name">$use_transparent_text</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">bool</span>
					<a href="#$use_wordlist" title="details" class="var-name">$use_wordlist</a>
				</div>
																<div class="var-title">
					<img src="../../media/images/Variable.png" alt=" " />
					<span class="var-type">string</span>
					<a href="#$wordlist_file" title="details" class="var-name">$wordlist_file</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																<div class="method-definition">
					<img src="../../media/images/Constructor.png" alt=" "/>
											<span class="method-result">Securimage</span>
										<a href="#Securimage" title="details" class="method-name">Securimage</a>
										()
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">boolean</span>
										<a href="#check" title="details" class="method-name">check</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>)
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#createCode" title="details" class="method-name">createCode</a>
										()
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getAudibleCode" title="details" class="method-name">getAudibleCode</a>
										()
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getCode" title="details" class="method-name">getCode</a>
										()
									</div>
																<div class="method-definition">
					<img src="../../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#show" title="details" class="method-name">show</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$background_image</span> = <span class="var-default">&quot;&quot;</span>])
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$arc_linethrough" id="$arc_linethrough"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$arc_linethrough</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">344</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">For added security, it is a good idea to draw arced lines over the letters to make it harder for bots to segment the letters.<br />  Two arced lines will be drawn over the text on each side of the image.<br />  This is currently expirimental and may be off in certain configurations.</p>
	
	
		
		

</div>
<a name="var$arc_line_colors" id="$arc_line_colors"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$arc_line_colors</span>
			 = <span class="var-default"> &quot;#8080ff&quot;</span>			(line <span class="line-number">353</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The colors or color of the arced lines.<br />  Use HTML hex notation with preceding # sign, and separate each value with a comma.<br />  This should be similar to your font color for single color images.</p>
	
	
		
		

</div>
<a name="var$audio_path" id="$audio_path"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$audio_path</span>
			 = <span class="var-default"> './audio/'</span>			(line <span class="line-number">362</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Full path to the WAV files to use to make the audio files, include trailing /.<br />  Name Files  [A-Z0-9].wav</p>
	<ul class="tags">
				<li><span class="field">since:</span> 1.0.1</li>
			</ul>
	
	
		
		

</div>
<a name="var$charset" id="$charset"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$charset</span>
			 = <span class="var-default"> 'ABCDEFGHKLMNPRSTUVWYZ23456789'</span>			(line <span class="line-number">120</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The character set for individual characters in the image.<br />  Letters are converted to uppercase.<br />  The font must support the letters or there may be problematic substitutions.</p>
	
	
		
		

</div>
<a name="var$code_length" id="$code_length"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$code_length</span>
			 = <span class="var-default"> 4</span>			(line <span class="line-number">111</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The length of the code to generate.</p>
	
	
		
		

</div>
<a name="var$draw_angled_lines" id="$draw_angled_lines"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$draw_angled_lines</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">326</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set to true to draw angled lines on the image in addition to the horizontal and vertical lines.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$draw_lines">Securimage::$draw_lines</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$draw_lines" id="$draw_lines"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$draw_lines</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">291</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Draw vertical and horizontal lines on the image.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$draw_lines_over_text">Securimage::$draw_lines_over_text</a></li>
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$line_thickness">Securimage::$line_thickness</a></li>
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$line_distance">Securimage::$line_distance</a></li>
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$line_color">Securimage::$line_color</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$draw_lines_over_text" id="$draw_lines_over_text"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$draw_lines_over_text</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">335</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Draw the lines over the text.<br />  If fales lines will be drawn before putting the text on the image.<br />  This can make the image hard for humans to read depending on the line thickness and distance.</p>
	
	
		
		

</div>
<a name="var$font_size" id="$font_size"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$font_size</span>
			 = <span class="var-default"> 24</span>			(line <span class="line-number">178</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The font size.<br />  Depending on your version of GD, this should be specified as the pixel size (GD1) or point size (GD2)<br /></p>
	
	
		
		

</div>
<a name="var$gd_font_file" id="$gd_font_file"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$gd_font_file</span>
			 = <span class="var-default"> 'gdfonts/bubblebath.gdf'</span>			(line <span class="line-number">152</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The GD font to use.<br />  Internal gd fonts can be loaded by their number.<br />  Alternatively, a file path can be given and the font will be loaded from file.</p>
	
	
		
		

</div>
<a name="var$gd_font_size" id="$gd_font_size"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$gd_font_size</span>
			 = <span class="var-default"> 20</span>			(line <span class="line-number">161</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The approximate size of the font in pixels.<br />  This does not control the size of the font because that is determined by the GD font itself.<br />  This is used to aid the calculations of positioning used by this class.<br /></p>
	
	
		
		

</div>
<a name="var$image_bg_color" id="$image_bg_color"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$image_bg_color</span>
			 = <span class="var-default"> &quot;#e3daed&quot;</span>			(line <span class="line-number">233</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The background color for the image.<br />  This should be specified in HTML hex format.<br />  Make sure to include the preceding # sign!</p>
	
	
		
		

</div>
<a name="var$image_height" id="$image_height"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$image_height</span>
			 = <span class="var-default"> 45</span>			(line <span class="line-number">96</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The desired width of the CAPTCHA image.</p>
	
	
		
		

</div>
<a name="var$image_type" id="$image_type"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$image_type</span>
			 = <span class="var-default"> SI_IMAGE_PNG</span>			(line <span class="line-number">104</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The image format for output.<br />  Valid options: SI_IMAGE_PNG, SI_IMAGE_JPG, SI_IMAGE_GIF</p>
	
	
		
		

</div>
<a name="var$image_width" id="$image_width"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$image_width</span>
			 = <span class="var-default"> 175</span>			(line <span class="line-number">89</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The desired width of the CAPTCHA image.</p>
	
	
		
		

</div>
<a name="var$line_color" id="$line_color"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$line_color</span>
			 = <span class="var-default"> &quot;#80BFFF&quot;</span>			(line <span class="line-number">300</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The color of the lines drawn on the image.<br />  Use HTML hex format with preceding # sign.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$draw_lines">Securimage::$draw_lines</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$line_distance" id="$line_distance"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$line_distance</span>
			 = <span class="var-default"> 5</span>			(line <span class="line-number">308</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">How far apart to space the lines from eachother in pixels.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$draw_lines">Securimage::$draw_lines</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$line_thickness" id="$line_thickness"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$line_thickness</span>
			 = <span class="var-default"> 1</span>			(line <span class="line-number">318</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">How thick to draw the lines in pixels.<br />  1-3 is ideal depending on distance</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$line_distance">Securimage::$line_distance</a></li>
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$draw_lines">Securimage::$draw_lines</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$multi_text_color" id="$multi_text_color"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$multi_text_color</span>
			 = <span class="var-default"> &quot;#0a68dd,#f65c47,#8d32fd&quot;</span>			(line <span class="line-number">261</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">String of HTML hex colors to use.<br />  Separate each possible color with commas.<br />  Be sure to precede each value with the # sign.</p>
	
	
		
		

</div>
<a name="var$text_angle_maximum" id="$text_angle_maximum"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$text_angle_maximum</span>
			 = <span class="var-default"> 20</span>			(line <span class="line-number">196</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The minimum angle in degrees, with 0 degrees being left-to-right reading text.<br />  Higher values represent a counter-clockwise rotation.<br />  For example, a value of 90 would result in bottom-to-top reading text.</p>
	
	
		
		

</div>
<a name="var$text_angle_minimum" id="$text_angle_minimum"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$text_angle_minimum</span>
			 = <span class="var-default"> -20</span>			(line <span class="line-number">187</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The minimum angle in degrees, with 0 degrees being left-to-right reading text.<br />  Higher values represent a counter-clockwise rotation.<br />  For example, a value of 90 would result in bottom-to-top reading text.</p>
	
	
		
		

</div>
<a name="var$text_color" id="$text_color"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$text_color</span>
			 = <span class="var-default"> &quot;#ff0000&quot;</span>			(line <span class="line-number">244</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The text color to use for drawing characters.<br /></p>
<p class="description"><p>This value is ignored if $use_multi_text is set to true.<br />  Make sure this contrasts well with the background color.<br />  Specify the color in HTML hex format with preceding # sign</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$use_multi_text">Securimage::$use_multi_text</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$text_maximum_distance" id="$text_maximum_distance"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$text_maximum_distance</span>
			 = <span class="var-default"> 33</span>			(line <span class="line-number">224</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Letters can be spaced apart at random distances.<br /></p>
<p class="description"><p>This is the maximum distance between two letters.<br />  This should be <em>at least</em> as wide as a font character.<br />  Small values can cause letters to be drawn over eachother.<br /></p></p>
	
	
		
		

</div>
<a name="var$text_minimum_distance" id="$text_minimum_distance"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$text_minimum_distance</span>
			 = <span class="var-default"> 30</span>			(line <span class="line-number">214</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Letters can be spaced apart at random distances.<br /></p>
<p class="description"><p>This is the minimum distance between two letters.<br />  This should be <em>at least</em> as wide as a font character.<br />  Small values can cause letters to be drawn over eachother.<br /></p></p>
	
	
		
		

</div>
<a name="var$text_transparency_percentage" id="$text_transparency_percentage"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$text_transparency_percentage</span>
			 = <span class="var-default"> 15</span>			(line <span class="line-number">278</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The percentage of transparency, 0 to 100.<br />  A value of 0 is completely opaque, 100 is completely transparent (invisble)</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$use_transparent_text">Securimage::$use_transparent_text</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$text_x_start" id="$text_x_start"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$text_x_start</span>
			 = <span class="var-default"> 8</span>			(line <span class="line-number">204</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The X-Position on the image where letter drawing will begin.<br />  This value is in pixels from the left side of the image.</p>
	
	
		
		

</div>
<a name="var$ttf_file" id="$ttf_file"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$ttf_file</span>
			 = <span class="var-default"> &quot;./elephant.ttf&quot;</span>			(line <span class="line-number">170</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The path to the TTF font file to load.</p>
	
	
		
		

</div>
<a name="var$use_gd_font" id="$use_gd_font"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$use_gd_font</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">143</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Whether to use a GD font instead of a TTF font.<br />  TTF offers more support and options, but use this if your PHP doesn't support TTF.<br /></p>
	
	
		
		

</div>
<a name="var$use_multi_text" id="$use_multi_text"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$use_multi_text</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">252</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set to true to use multiple colors for each character.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$multi_text_color">Securimage::$multi_text_color</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$use_transparent_text" id="$use_transparent_text"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">boolean</span>
			<span class="var-name">$use_transparent_text</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">269</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set to true to make the characters appear transparent.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../Securimage/classes/Securimage.html#var$text_transparency_percentage">Securimage::$text_transparency_percentage</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$use_wordlist" id="$use_wordlist"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$use_wordlist</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">135</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">True to use a word list file instead of a random code</p>
	
	
		
		

</div>
<a name="var$wordlist_file" id="$wordlist_file"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$wordlist_file</span>
			 = <span class="var-default"> '../words/words.txt'</span>			(line <span class="line-number">128</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create codes using this word list</p>
	<ul class="tags">
				<li><span class="field">var:</span> The path to the word list to use for creating CAPTCHA codes</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodSecurimage" id="Securimage"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Constructor.png" />
		<span class="method-title">Constructor Securimage</span> (line <span class="line-number">419</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class constructor.<br />  Because the class uses sessions, this will attempt to start a session if there is no previous one.<br />  If you do not start a session before calling the class, the constructor must be called before any  output is sent to the browser.</p>
<p class="description"><p><div class="src-code"><ol><li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-var">$securimage&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><a href="../../Securimage/classes/Securimage.html#methodSecurimage">Securimage</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	
	<div class="method-signature">
		<span class="method-result">Securimage</span>
		<span class="method-name">
			Securimage
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodcheck" id="check"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">check</span> (line <span class="line-number">462</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Validate the code entered by the user.</p>
<p class="description"><p><div class="src-code"><ol><li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-var">$code&nbsp;</span>=&nbsp;<span class="src-var">$_POST</span><span class="src-sym">[</span><span class="src-str">'code'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-key">if&nbsp;</span><span class="src-sym">(</span><span class="src-var">$securimage</span><span class="src-sym">-&gt;</span><a href="../../Securimage/classes/Securimage.html#methodcheck">check</a><span class="src-sym">(</span><span class="src-var">$code</span><span class="src-sym">)&nbsp;</span>==&nbsp;<span class="src-id">false</span><span class="src-sym">)&nbsp;</span><span class="src-sym">{</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-key">die</span><span class="src-sym">(</span><span class="src-str">&quot;Sorry,&nbsp;the&nbsp;code&nbsp;entered&nbsp;did&nbsp;not&nbsp;match.&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-sym">}&nbsp;</span><span class="src-key">else&nbsp;</span><span class="src-sym">{</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$valid&nbsp;</span>=&nbsp;<span class="src-id">true</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-sym">}</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> true if the code was correct, false if not</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			check
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$code</span><span class="var-description">: The code the user entered</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateCode" id="createCode"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">createCode</span> (line <span class="line-number">670</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create a code and save to the session</p>
	<ul class="tags">
				<li><span class="field">since:</span> 1.0.1</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			createCode
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetAudibleCode" id="getAudibleCode"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">getAudibleCode</span> (line <span class="line-number">777</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get WAV file data of the spoken code.<br />  This is appropriate for output to the browser as audio/x-wav</p>
	<ul class="tags">
				<li><span class="field">return:</span> WAV data</li>
				<li><span class="field">since:</span> 1.0.1</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getAudibleCode
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetCode" id="getCode"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">getCode</span> (line <span class="line-number">831</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the captcha code</p>
	<ul class="tags">
				<li><span class="field">since:</span> 1.0.1</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getCode
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodshow" id="show"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../../media/images/Method.png" />
		<span class="method-title">show</span> (line <span class="line-number">439</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate a code and output the image to the browser.</p>
<p class="description"><p><div class="src-code"><ol><li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-php">&lt;?php</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-inc">include&nbsp;</span><span class="src-str">'securimage.php'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-var">$securimage&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><a href="../../Securimage/classes/Securimage.html#methodSecurimage">Securimage</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-var">$securimage</span><span class="src-sym">-&gt;</span><a href="../../Securimage/classes/Securimage.html#methodshow">show</a><span class="src-sym">(</span><span class="src-str">'bg.jpg'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;<span class="src-php">?&gt;</span></div></li>
</ol></div></p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			show
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$background_image</span> = <span class="var-default">&quot;&quot;</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$background_image</span><span class="var-description">: The path to an image to use as the background for the CAPTCHA</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Thu, 18 Jun 2009 14:08:00 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>